<html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <title>use_awaitable_t</title>
    <link rel="stylesheet" href="../../boostbook.css" type="text/css">
    <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
    <link rel="home" href="../../index.html" title="Asio">
    <link rel="up" href="../reference.html" title="Reference">
    <link rel="prev" href="use_awaitable.html" title="use_awaitable">
    <link rel="next" href="use_awaitable_t/as_default_on.html" title="use_awaitable_t::as_default_on">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
    <tr>
        <td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../asio.png"></td>
    </tr>
</table>
<hr>
<div class="spirit-nav">
    <a accesskey="p" href="use_awaitable.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u"
                                                                                           href="../reference.html"><img
        src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png"
                                                                                      alt="Home"></a><a accesskey="n"
                                                                                                        href="use_awaitable_t/as_default_on.html"><img
        src="../../next.png" alt="Next"></a>
</div>
<div class="section">
    <div class="titlepage">
        <div>
            <div><h3 class="title">
                <a name="asio.reference.use_awaitable_t"></a><a class="link" href="use_awaitable_t.html"
                                                                title="use_awaitable_t">use_awaitable_t</a>
            </h3></div>
        </div>
    </div>
    <p>
        <a class="indexterm" name="asio.indexterm.use_awaitable_t"></a>
    </p>
    <p>
        A completion token that represents the currently executing coroutine.
    </p>
    <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
    <span class="keyword">typename</span> <a class="link" href="Executor1.html"
                                             title="Executor requirements">Executor</a> <span
                class="special">=</span> <span class="identifier">any_io_executor</span><span
                class="special">&gt;</span>
<span class="keyword">struct</span> <span class="identifier">use_awaitable_t</span>
</pre>
    <h5>
        <a name="asio.reference.use_awaitable_t.h0"></a>
        <span><a name="asio.reference.use_awaitable_t.types"></a></span><a class="link"
                                                                           href="use_awaitable_t.html#asio.reference.use_awaitable_t.types">Types</a>
    </h5>
    <div class="informaltable">
        <table class="table">
            <colgroup>
                <col>
                <col>
            </colgroup>
            <thead>
            <tr>
                <th>
                    <p>
                        Name
                    </p>
                </th>
                <th>
                    <p>
                        Description
                    </p>
                </th>
            </tr>
            </thead>
            <tbody>
            <tr>
                <td>
                    <p>
                        <a class="link" href="use_awaitable_t__executor_with_default.html"
                           title="use_awaitable_t::executor_with_default"><span class="bold"><strong>executor_with_default</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Adapts an executor to add the use_awaitable_t completion token
                        as the default.
                    </p>
                </td>
            </tr>
            </tbody>
        </table>
    </div>
    <h5>
        <a name="asio.reference.use_awaitable_t.h1"></a>
        <span><a name="asio.reference.use_awaitable_t.member_functions"></a></span><a class="link"
                                                                                      href="use_awaitable_t.html#asio.reference.use_awaitable_t.member_functions">Member
        Functions</a>
    </h5>
    <div class="informaltable">
        <table class="table">
            <colgroup>
                <col>
                <col>
            </colgroup>
            <thead>
            <tr>
                <th>
                    <p>
                        Name
                    </p>
                </th>
                <th>
                    <p>
                        Description
                    </p>
                </th>
            </tr>
            </thead>
            <tbody>
            <tr>
                <td>
                    <p>
                        <a class="link" href="use_awaitable_t/as_default_on.html"
                           title="use_awaitable_t::as_default_on"><span
                                class="bold"><strong>as_default_on</strong></span></a> <span
                            class="silver">[static]</span>
                    </p>
                </td>
                <td>
                    <p>
                        Function helper to adapt an I/O object to use use_awaitable_t as
                        its default completion token type.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="use_awaitable_t/use_awaitable_t.html"
                           title="use_awaitable_t::use_awaitable_t"><span class="bold"><strong>use_awaitable_t</strong></span></a>
                        <span class="silver">[constructor]</span>
                    </p>
                </td>
                <td>
                    <p>
                        Default constructor. <br> <span class="silver"> —</span><br> Constructor used to specify
                        file name, line, and function name.
                    </p>
                </td>
            </tr>
            </tbody>
        </table>
    </div>
    <p>
        The <code class="computeroutput"><span class="identifier">use_awaitable_t</span></code> class,
        with its value <code class="computeroutput"><span class="identifier">use_awaitable</span></code>,
        is used to represent the currently executing coroutine. This completion token
        may be passed as a handler to an asynchronous operation. For example:
    </p>
    <pre class="programlisting"><span class="identifier">awaitable</span><span class="special">&lt;</span><span
            class="keyword">void</span><span class="special">&gt;</span> <span
            class="identifier">my_coroutine</span><span class="special">()</span>
<span class="special">{</span>
  <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span
                class="identifier">n</span> <span class="special">=</span> <span
                class="identifier">co_await</span> <span class="identifier">my_socket</span><span
                class="special">.</span><span class="identifier">async_read_some</span><span
                class="special">(</span><span class="identifier">buffer</span><span class="special">,</span> <span
                class="identifier">use_awaitable</span><span class="special">);</span>
  <span class="special">...</span>
<span class="special">}</span>
</pre>
    <p>
        When used with co_await, the initiating function (<code class="computeroutput"><span class="identifier">async_read_some</span></code>
        in the above example) suspends the current coroutine. The coroutine is resumed
        when the asynchronous operation completes, and the result of the operation
        is returned.
    </p>
    <h5>
        <a name="asio.reference.use_awaitable_t.h2"></a>
        <span><a name="asio.reference.use_awaitable_t.requirements"></a></span><a class="link"
                                                                                  href="use_awaitable_t.html#asio.reference.use_awaitable_t.requirements">Requirements</a>
    </h5>
    <p>
        <span class="emphasis"><em>Header: </em></span><code class="literal">asio/use_awaitable.hpp</code>
    </p>
    <p>
        <span class="emphasis"><em>Convenience header: </em></span><code class="literal">asio.hpp</code>
    </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%">
    <tr>
        <td align="left"></td>
        <td align="right">
            <div class="copyright-footer">Copyright © 2003-2022 Christopher M. Kohlhoff<p>
                Distributed under the Boost Software License, Version 1.0. (See accompanying
                file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
            </p>
            </div>
        </td>
    </tr>
</table>
<hr>
<div class="spirit-nav">
    <a accesskey="p" href="use_awaitable.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u"
                                                                                           href="../reference.html"><img
        src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png"
                                                                                      alt="Home"></a><a accesskey="n"
                                                                                                        href="use_awaitable_t/as_default_on.html"><img
        src="../../next.png" alt="Next"></a>
</div>
</body>
</html>
